home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / p_man / cat3 / Xm / DialogSh.z / DialogSh
Text File  |  1998-10-30  |  20KB  |  265 lines

  1.  
  2.  
  3.  
  4.      XXXXmmmmDDDDiiiiaaaallllooooggggSSSShhhheeeellllllll((((3333XXXX))))         UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV         XXXXmmmmDDDDiiiiaaaallllooooggggSSSShhhheeeellllllll((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmDDDDiiiiaaaallllooooggggSSSShhhheeeellllllll - The DialogShell widget class
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.           #include <Xm/DialogS.h>
  13.  
  14.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  15.           This page documents Motif 2.1.
  16.  
  17.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  18.           Modal and modeless dialogs use DialogShell as the Shell
  19.           parent.  DialogShell widgets cannot be iconified. Instead,
  20.           all secondary DialogShell widgets associated with an
  21.           ApplicationShell widget are iconified and de-iconified as a
  22.           group with the primary widget.
  23.  
  24.           The client indirectly manipulates DialogShell through the
  25.           convenience interfaces during creation, and it can directly
  26.           manipulate its BulletinBoard-derived child.  Much of the
  27.           functionality of DialogShell assumes that its child is a
  28.           BulletinBoard subclass, although it can potentially stand
  29.           alone.
  30.  
  31.           Setting XXXXmmmmNNNNhhhheeeeiiiigggghhhhtttt, XXXXmmmmNNNNwwwwiiiiddddtttthhhh, or XXXXmmmmNNNNbbbboooorrrrddddeeeerrrrWWWWiiiiddddtttthhhh for either a
  32.           DialogShell or its managed child usually sets that resource
  33.           to the same value in both the parent and the child. When an
  34.           off-the-spot input method exists, the height and width of
  35.           the shell may be greater than those of the managed child in
  36.           order to accommodate the input method.  In this case,
  37.           setting XXXXmmmmNNNNhhhheeeeiiiigggghhhhttttor XXXXmmmmNNNNwwwwiiiiddddtttthhhh for the shell does not
  38.           necessarily set that resource to the same value in the
  39.           managed child, and setting XXXXmmmmNNNNhhhheeeeiiiigggghhhhttttor XXXXmmmmNNNNwwwwiiiiddddtttthhhhfor the child
  40.           does not necessarily set that resource to the same value in
  41.           the shell.
  42.  
  43.           For the managed child of a DialogShell, regardless of the
  44.           value of the shell's XXXXmmmmNNNNaaaalllllllloooowwwwSSSShhhheeeellllllllRRRReeeessssiiiizzzzeeee resource, setting
  45.           XXXXmmmmNNNNxxxx or XXXXmmmmNNNNyyyysets the corresponding resource of the parent
  46.           but does not change the child's position relative to the
  47.           parent.  The XXXXttttGGGGeeeettttVVVVaaaalllluuuueeeessss resource for the child's XXXXmmmmNNNNxxxx or
  48.           XXXXmmmmNNNNyyyy yields the value of the corresponding resource in the
  49.           parent.  The x and y-coordinates of the child's upper left
  50.           outside corner relative to the parent's upper left inside
  51.           corner are both 0 (zero) minus the value of XXXXmmmmNNNNbbbboooorrrrddddeeeerrrrWWWWiiiiddddtttthhhh.
  52.  
  53.           Note that the _I_n_t_e_r-_C_l_i_e_n_t _C_o_m_m_u_n_i_c_a_t_i_o_n _C_o_n_v_e_n_t_i_o_n_s _M_a_n_u_a_l
  54.           (ICCCM) allows a window manager to change or control the
  55.           border width of a reparented top-level window.
  56.  
  57.           DialogShell uses the _X_m_Q_T_d_i_a_l_o_g_S_h_e_l_l_S_a_v_v_y trait.
  58.  
  59.         CCCCllllaaaasssssssseeeessss
  60.  
  61.  
  62.  
  63.      PPPPaaaaggggeeee 1111                                         ((((pppprrrriiiinnnntttteeeedddd 11110000////22224444////99998888))))
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmDDDDiiiiaaaallllooooggggSSSShhhheeeellllllll((((3333XXXX))))         UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV         XXXXmmmmDDDDiiiiaaaallllooooggggSSSShhhheeeellllllll((((3333XXXX))))
  71.  
  72.  
  73.  
  74.           DialogShell inherits behavior, resources, and traits from
  75.           the CCCCoooorrrreeee, CCCCoooommmmppppoooossssiiiitttteeee, SSSShhhheeeellllllll, WWWWMMMMSSSShhhheeeellllllll, VVVVeeeennnnddddoooorrrrSSSShhhheeeellllllll, and
  76.           TTTTrrrraaaannnnssssiiiieeeennnnttttSSSShhhheeeellllllll classes.
  77.  
  78.           The class pointer is _x_m_D_i_a_l_o_g_S_h_e_l_l_W_i_d_g_e_t_C_l_a_s_s.
  79.  
  80.           The class name is XXXXmmmmDDDDiiiiaaaallllooooggggSSSShhhheeeellllllll.
  81.  
  82.         NNNNeeeewwww RRRReeeessssoooouuuurrrrcccceeeessss
  83.           DialogShell defines no new resources but overrides the
  84.           XXXXmmmmNNNNddddeeeelllleeeetttteeeeRRRReeeessssppppoooonnnnsssseeeeresource in the VVVVeeeennnnddddoooorrrrSSSShhhheeeellllllll class.
  85.  
  86.         IIIInnnnhhhheeeerrrriiiitttteeeedddd RRRReeeessssoooouuuurrrrcccceeeessss
  87.           DialogShell inherits behavior and resources from the
  88.           superclasses described in the following tables, which define
  89.           sets of widget resources used by the programmer to specify
  90.           data.
  91.  
  92.           For a complete description of each resource, refer to the
  93.           reference page for that superclass.  The programmer can also
  94.           set the resource values for the inherited classes to set
  95.           attributes for this widget. To reference a resource by name
  96.           or by class in a ....XXXXddddeeeeffffaaaauuuullllttttssss file, remove the XXXXmmmmNNNN or XXXXmmmmCCCC
  97.           prefix and use the remaining letters. To specify one of the
  98.           defined values for a resource in a ....XXXXddddeeeeffffaaaauuuullllttttssss file, remove
  99.           the XXXXmmmm prefix and use the remaining letters (in either
  100.           lowercase or uppercase, but include any underscores between
  101.           words).  The codes in the access column indicate if the
  102.           given resource can be set at creation time (C), set by using
  103.           XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss (S), retrieved by using XXXXttttGGGGeeeettttVVVVaaaalllluuuueeeessss (G), or is
  104.           not applicable (N/A).
  105.  
  106.                            TTTTrrrraaaannnnssssiiiieeeennnnttttSSSShhhheeeellllllll RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  107.           NNNNaaaammmmeeee              CCCCllllaaaassssssss             TTTTyyyyppppeeee     DDDDeeeeffffaaaauuuulllltttt   AAAAcccccccceeeessssssss
  108.           XmNtransientFor   XmCTransientFor   Widget   NULL      CSG
  109.  
  110.                                            VVVVeeeennnnddddoooorrrrSSSShhhheeeellllllll RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  111.           NNNNaaaammmmeeee                     CCCCllllaaaassssssss                    TTTTyyyyppppeeee            DDDDeeeeffffaaaauuuulllltttt           AAAAcccccccceeeessssssss
  112.           XmNaudibleWarning        XmCAudibleWarning        unsigned char   XmBELL            CSG
  113.           XmNbuttonFontList        XmCButtonFontList        XmFontList      dynamic           CSG
  114.           XmNbuttonRenderTable     XmCButtonRenderTable     XmRenderTable   dynamic           CSG
  115.           XmNdefaultFontList       XmCDefaultFontList       XmFontList      dynamic           CG
  116.           XmNdeleteResponse        XmCDeleteResponse        unsigned char   XmUNMAP           CSG
  117.           XmNinputMethod           XmCInputMethod           String          NULL              CSG
  118.           XmNinputPolicy           XmCInputPolicy           XmInputPolicy   XmPER_SHELL       CSG
  119.           XmNkeyboardFocusPolicy   XmCKeyboardFocusPolicy   unsigned char   XmEXPLICIT        CSG
  120.           XmNlabelFontList         XmCLabelFontList         XmFontList      dynamic           CSG
  121.           XmNlabelRenderTable      XmCLabelRenderTabel      XmRenderTable   dynamic           CSG
  122.           XmNlayoutDirection       XmCLayoutDirection       XmDirection     XmLEFT_TO_RIGHT   CG
  123.           XmNmwmDecorations        XmCMwmDecorations        int             -1                CG
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                         (printed 10/24/98)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXmmmmDDDDiiiiaaaallllooooggggSSSShhhheeeellllllll((((3333XXXX))))         UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV         XXXXmmmmDDDDiiiiaaaallllooooggggSSSShhhheeeellllllll((((3333XXXX))))
  137.  
  138.  
  139.  
  140.           XmNmwmFunctions          XmCMwmFunctions          int             -1                CG
  141.           XmNmwmInputMode          XmCMwmInputMode          int             -1                CG
  142.           XmNmwmMenu               XmCMwmMenu               String          NULL              CG
  143.           XmNpreeditType           XmCPreeditType           String          dynamic           CSG
  144.           XmNshellUnitType         XmCShellUnitType         unsigned char   XmPIXELS          CSG
  145.           XmNtextFontList          XmCTextFontList          XmFontList      dynamic           CSG
  146.           XmNtextRenderTable       XmCTextRenderTable       XmRenderTable   dynamic           CSG
  147.           XmNunitType              XmCUnitType              unsigned char   XmPIXELS          CSG
  148.           XmNuseAsyncGeometry      XmCUseAsyncGeometry      Boolean         False             CSG
  149.  
  150.                                        WWWWMMMMSSSShhhheeeellllllll RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  151.           NNNNaaaammmmeeee               CCCCllllaaaassssssss              TTTTyyyyppppeeee      DDDDeeeeffffaaaauuuulllltttt                 AAAAcccccccceeeessssssss
  152.           XmNbaseHeight      XmCBaseHeight      int       XtUnspecifiedShellInt   CSG
  153.           XmNbaseWidth       XmCBaseWidth       int       XtUnspecifiedShellInt   CSG
  154.           XmNheightInc       XmCHeightInc       int       XtUnspecifiedShellInt   CSG
  155.           XmNiconMask        XmCIconMask        Pixmap    NULL                    CSG
  156.           XmNiconPixmap      XmCIconPixmap      Pixmap    NULL                    CSG
  157.           XmNiconWindow      XmCIconWindow      Window    NULL                    CSG
  158.           XmNiconX           XmCIconX           int       XtUnspecifiedShellInt   CSG
  159.           XmNiconY           XmCIconY           int       XtUnspecifiedShellInt   CSG
  160.           XmNinitialState    XmCInitialState    int       NormalState             CSG
  161.           XmNinput           XmCInput           Boolean   True                    CSG
  162.           XmNmaxAspectX      XmCMaxAspectX      int       XtUnspecifiedShellInt   CSG
  163.           XmNmaxAspectY      XmCMaxAspectY      int       XtUnspecifiedShellInt   CSG
  164.           XmNmaxHeight       XmCMaxHeight       int       XtUnspecifiedShellInt   CSG
  165.           XmNmaxWidth        XmCMaxWidth        int       XtUnspecifiedShellInt   CSG
  166.           XmNminAspectX      XmCMinAspectX      int       XtUnspecifiedShellInt   CSG
  167.           XmNminAspectY      XmCMinAspectY      int       XtUnspecifiedShellInt   CSG
  168.           XmNminHeight       XmCMinHeight       int       XtUnspecifiedShellInt   CSG
  169.           XmNminWidth        XmCMinWidth        int       XtUnspecifiedShellInt   CSG
  170.           XmNtitle           XmCTitle           String    dynamic                 CSG
  171.           XmNtitleEncoding   XmCTitleEncoding   Atom      dynamic                 CSG
  172.           XmNtransient       XmCTransient       Boolean   True                    CSG
  173.           XmNwaitForWm       XmCWaitForWm       Boolean   True                    CSG
  174.           XmNwidthInc        XmCWidthInc        int       XtUnspecifiedShellInt   CSG
  175.           XmNwindowGroup     XmCWindowGroup     Window    dynamic                 CSG
  176.           XmNwinGravity      XmCWinGravity      int       dynamic                 CSG
  177.           XmNwmTimeout       XmCWmTimeout       int       5000 ms                 CSG
  178.  
  179.                NNNNooootttteeee::::
  180.  
  181.                If values for XXXXmmmmNNNNmmmmiiiinnnnWWWWiiiiddddtttthhhh and XXXXmmmmNNNNmmmmiiiinnnnHHHHeeeeiiiigggghhhhtttt are present,
  182.                and values for XXXXmmmmNNNNbbbbaaaasssseeeeWWWWiiiiddddtttthhhh and XXXXmmmmNNNNbbbbaaaasssseeeeHHHHeeeeiiiigggghhhhtttt are
  183.                absent, XXXXmmmmNNNNmmmmiiiinnnnWWWWiiiiddddtttthhhh and XXXXmmmmNNNNmmmmiiiinnnnHHHHeeeeiiiigggghhhhtttt will be used as
  184.                default values for XXXXmmmmNNNNbbbbaaaasssseeeeWWWWiiiiddddtttthhhhand XXXXmmmmNNNNbbbbaaaasssseeeeHHHHeeeeiiiigggghhhhtttt, and
  185.                these values will be added to the shell size specified
  186.                by the user.  To work around this, add arguments during
  187.                widget creation to explicitly set XXXXmmmmNNNNbbbbaaaasssseeeeWWWWiiiiddddtttthhhh and
  188.                XXXXmmmmNNNNbbbbaaaasssseeeeHHHHeeeeiiiigggghhhhtttt to zero.
  189.  
  190.                                                    SSSShhhheeeellllllll RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  191.           NNNNaaaammmmeeee                      CCCCllllaaaassssssss                     TTTTyyyyppppeeee                     DDDDeeeeffffaaaauuuulllltttt          AAAAcccccccceeeessssssss
  192.  
  193.  
  194.  
  195.      Page 3                                         (printed 10/24/98)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      XXXXmmmmDDDDiiiiaaaallllooooggggSSSShhhheeeellllllll((((3333XXXX))))         UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV         XXXXmmmmDDDDiiiiaaaallllooooggggSSSShhhheeeellllllll((((3333XXXX))))
  203.  
  204.  
  205.  
  206.           XmNallowShellResize       XmCAllowShellResize       Boolean                  False            CG
  207.           XmNcreatePopupChildProc   XmCCreatePopupChildProc   XtCreatePopupChildProc   NULL             CSG
  208.           XmNgeometry               XmCGeometry               String                   NULL             CSG
  209.           XmNoverrideRedirect       XmCOverrideRedirect       Boolean                  False            CSG
  210.           XmNpopdownCallback        XmCCallback               XtCallbackList           NULL             C
  211.           XmNpopupCallback          XmCCallback               XtCallbackList           NULL             C
  212.           XmNsaveUnder              XmCSaveUnder              Boolean                  True             CSG
  213.           XmNvisual                 XmCVisual                 Visual *                 CopyFromParent   CSG
  214.  
  215.                                   CCCCoooommmmppppoooossssiiiitttteeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  216.           NNNNaaaammmmeeee                CCCCllllaaaassssssss               TTTTyyyyppppeeee          DDDDeeeeffffaaaauuuulllltttt   AAAAcccccccceeeessssssss
  217.           XmNchildren         XmCReadOnly         WidgetList    NULL      G
  218.           XmNinsertPosition   XmCInsertPosition   XtOrderProc   NULL      CSG
  219.           XmNnumChildren      XmCReadOnly         Cardinal      0         G
  220.  
  221.                                                         CCCCoooorrrreeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  222.           NNNNaaaammmmeeee                            CCCCllllaaaassssssss                           TTTTyyyyppppeeee             DDDDeeeeffffaaaauuuulllltttt                AAAAcccccccceeeessssssss
  223.           XmNaccelerators                 XmCAccelerators                 XtAccelerators   dynamic                CSG
  224.           XmNancestorSensitive            XmCSensitive                    Boolean          dynamic                G
  225.           XmNbackground                   XmCBackground                   Pixel            dynamic                CSG
  226.           XmNbackgroundPixmap             XmCPixmap                       Pixmap           XmUNSPECIFIED_PIXMAP   CSG
  227.           XmNborderColor                  XmCBorderColor                  Pixel            XtDefaultForeground    CSG
  228.           XmNborderPixmap                 XmCPixmap                       Pixmap           XmUNSPECIFIED_PIXMAP   CSG
  229.           XmNborderWidth                  XmCBorderWidth                  Dimension        0                      CSG
  230.           XmNcolormap                     XmCColormap                     Colormap         dynamic                CG
  231.           XmNdepth                        XmCDepth                        int              dynamic                CG
  232.           XmNdestroyCallback              XmCCallback                     XtCallbackList   NULL                   C
  233.           XmNheight                       XmCHeight                       Dimension        dynamic                CSG
  234.           XmNinitialResourcesPersistent   XmCInitialResourcesPersistent   Boolean          True                   C
  235.           XmNmappedWhenManaged            XmCMappedWhenManaged            Boolean          True                   CSG
  236.           XmNscreen                       XmCScreen                       Screen *         dynamic                CG
  237.           XmNsensitive                    XmCSensitive                    Boolean          True                   CSG
  238.           XmNtranslations                 XmCTranslations                 XtTranslations   dynamic                CSG
  239.           XmNwidth                        XmCWidth                        Dimension        dynamic                CSG
  240.           XmNx                            XmCPosition                     Position         0                      CSG
  241.           XmNy                            XmCPosition                     Position         0                      CSG
  242.  
  243.         TTTTrrrraaaannnnssssllllaaaattttiiiioooonnnnssss
  244.           There are no translations for XmDialogShell.
  245.  
  246.      RRRREEEELLLLAAAATTTTEEEEDDDD
  247.           CCCCoooommmmppppoooossssiiiitttteeee(3), CCCCoooorrrreeee(3), SSSShhhheeeellllllll(3), TTTTrrrraaaannnnssssiiiieeeennnnttttSSSShhhheeeellllllll(3),
  248.           WWWWMMMMSSSShhhheeeellllllll(3), VVVVeeeennnnddddoooorrrrSSSShhhheeeellllllll(3), and XXXXmmmmCCCCrrrreeeeaaaatttteeeeDDDDiiiiaaaallllooooggggSSSShhhheeeellllllll(3).
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.      Page 4                                         (printed 10/24/98)
  262.  
  263.  
  264.  
  265.